Skip to content

Ephemeral messages; _message partial #2543

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Ephemeral messages; _message partial #2543

wants to merge 2 commits into from

Conversation

SimonWoolf
Copy link
Member

@SimonWoolf SimonWoolf commented Apr 17, 2025

Adds docs for ephemeral messages to pub-sub-advanced.

I was going to update the extras description in message objects to add ephemeral but was irked by having to make the change in 3 places, which all seemed to have copied and pasted the Message types from the message partial instead of just including the partial. (And then inevitably diverged as people only made fixes to one or two of them, which is why partials are good). I couldn't see any reason given in the commit message that did the duplication, so I've taken the liberty of deduplicating (taking the text from the realtime-api version since that seems to have been kept more up to date than the one in hte partial).

PUB-1317

So we're not making the same change in multiple places.

Copy the version from realtime-sdk to the partial since it seemed to
have been kept more up to date than the partial version. (which is the
sort of drift that we can avoid exactly by using partials!)
@SimonWoolf SimonWoolf requested a review from a team April 17, 2025 10:37
Copy link

coderabbitai bot commented Apr 17, 2025

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@ably-ci ably-ci temporarily deployed to ably-docs-ephemeral-rcfslrrjmw April 17, 2025 10:37 Inactive
Copy link
Contributor

@m-hulbert m-hulbert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this, Simon.

My only comment would be whether you think it's worth using an example other than Chat here? Whilst it's valid to build chat using Pub/Sub, I think we should be highlighting other use cases now that we have Ably Chat.

@SimonWoolf
Copy link
Member Author

The main advantage of using a chatroom as an example is it's intuitive and universally understandable. Everyone knows what a chatroom is, and the basic shape of the solution (i.e. a chatroom maps to an ably channel) is so obvious you don't need to say it.

Say I instead used an example of using ably for a service discovery layer in a cluster, where an ably channel is used for each 'visibility class', a set of servers which should all be visible to each other and able to discover each other's addresses, where they might enter presence to announce themselves; which might then want to use ephemeral messaging to broadcast how busy/loaded they are minute-to-minute, where you'd want to persist the history of presence changes but don't care about load history.

I just needed to use 47 words to achieve what in the other example I achieved by saying "Say you have a chat room". And I would guess a good chunk of people reading the doc wouldn't get it. The chat room is an example that everyone would get instantly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants